chore: add CONTRIBUTING.md, SECURITY.md, and PR template#8
Merged
Conversation
Three standard OSS files to harden the project surface as the SDK starts getting real downloads: CONTRIBUTING.md Setup (pip install -e .[dev]), how to run lint/types/tests, optional smoke test against a real token, branch / commit / PR conventions, bug-reporting checklist, release process. Calls out what's in scope (bug fixes, doc improvements, new endpoint wrappers) vs not (adding a brand-new social platform — backend work first). SECURITY.md GitHub uses this to populate the repo's Security tab. Documents supported versions (0.1.x only), how to report vulnerabilities ([email protected], not a public issue), our SLA (ack in 72h, initial assessment in 7 days), and what's out of scope (rate limits, public-by-design data exposure, etc.). .github/PULL_REQUEST_TEMPLATE.md Pre-fills new PR descriptions with a Summary / Test plan / Checklist structure. Asks contributors to confirm ruff + mypy + pytest pass, smoke test re-run for typed-model methods, CHANGELOG updated. Lightweight, no enforcement. None of these change any code, tests, or behaviour — purely documentation + governance scaffolding. Ruff and the test suite are unaffected.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three standard OSS files to harden the project surface as the SDK starts getting real downloads. None change code or behaviour.
Files added
`CONTRIBUTING.md`
`SECURITY.md`
GitHub uses this file to populate the repo's Security tab.
`.github/PULL_REQUEST_TEMPLATE.md`
Pre-fills new PR descriptions with a Summary / Test plan / Checklist structure. Reminds contributors to:
Lightweight, no enforcement — just a checklist humans can ignore if irrelevant.
What does NOT change
Test plan